NFC Outcome data definitions

NFC Outcome structs & macros used to handle transaction by EP & Kernels. More...

Data Structures
struct	tag_NFC_OUTCOME_UI
	Outcome User Interface struct definition, version 0. More...
struct	tag_NFC_OUTCOME
	Outcome User Interface struct definition, version 0. More...

Macros
#define	NFC_OUTCOME_UI_RESET(UI, SIZE)
	UI reset macro definition. More...
#define	NFC_OUTCOME_UI_SET_LANG_PREF(UI, TRAN_DATA)
	UI set lang pref macro definition. More...
#define	NFC_OUTCOME_UI_INIT(UI, SIZE, TRAN_DATA)
	UI init with lang pref macro definition. More...
#define	NFC_OUTCOME_RESET(DATA, SIZE)
	Outcome reset macro definition. More...
#define	NFC_OUTCOME_INIT(DATA, SIZE, TRAN_DATA)
	Outcome reset macro definition. More...
#define	NFC_OUTCOME_CHECK(OUTCOME, MIN_SIZE, MIN_VER)   (((OUTCOME) != KER_NULL) && ((OUTCOME)->usSize >= (MIN_SIZE)) && ((OUTCOME)->btVersion >= (MIN_VER)))
	Outcome check macro definition.
typedef struct tag_NFC_OUTCOME_UI	NFC_OUTCOME_UI
	Outcome User Interface struct definition, version 0.
typedef struct tag_NFC_OUTCOME	NFC_OUTCOME
	Outcome User Interface struct definition, version 0.
#define	NFC_OUTCOME_UI_MSG_NA   0xFF
	Outcome User Interface Message ID definitions. More...
#define	NFC_OUTCOME_UI_MSG_APPROVED   0x03
#define	NFC_OUTCOME_UI_MSG_NOT_AUTHORISED   0x07
#define	NFC_OUTCOME_UI_MSG_ENTER_PIN   0x09
#define	NFC_OUTCOME_UI_MSG_PROCESSING_ERROR   0x0F
#define	NFC_OUTCOME_UI_MSG_REMOVE_CARD   0x10
#define	NFC_OUTCOME_UI_MSG_WELCOME   0x14
#define	NFC_OUTCOME_UI_MSG_PRESENT_CARD   0x15
#define	NFC_OUTCOME_UI_MSG_PROCESSING   0x16
#define	NFC_OUTCOME_UI_MSG_CARD_READ_OK_REMOVE_CARD   0x17
#define	NFC_OUTCOME_UI_MSG_INSERT_OR_SWIPE_CARD   0x18
#define	NFC_OUTCOME_UI_MSG_PRESENT_ONE_CARD_ONLY   0x19
#define	NFC_OUTCOME_UI_MSG_APPROVED_SIGN   0x1A
#define	NFC_OUTCOME_UI_MSG_AUTHORISATION_WAIT   0x1B
#define	NFC_OUTCOME_UI_MSG_INSERT_OR_SWIPE_OR_TRY_ANOTHER   0x1C
#define	NFC_OUTCOME_UI_MSG_INSERT_CARD   0x1D
#define	NFC_OUTCOME_UI_MSG_BLANK   0x1E
#define	NFC_OUTCOME_UI_MSG_SEE_PHONE_INSTRUCTIONS   0x20
#define	NFC_OUTCOME_UI_MSG_PRESENT_CARD_AGAIN   0x21
#define	NFC_OUTCOME_UI_MSG_EXPIRED_ONLINE   0xA0
#define	NFC_OUTCOME_UI_MSG_EXPIRED_DECLINE   0xA1
#define	NFC_OUTCOME_UI_NA   0x00
	Outcome User Interface status types definitions. More...
#define	NFC_OUTCOME_UI_NOT_READY   0x01
#define	NFC_OUTCOME_UI_IDLE   0x02
#define	NFC_OUTCOME_UI_READY_TO_READ   0x03
#define	NFC_OUTCOME_UI_PROCESSING   0x04
#define	NFC_OUTCOME_UI_CARD_READ_SUCCESS   0x05
#define	NFC_OUTCOME_UI_ERROR_PROCESSING   0x06
#define	NFC_OUTCOME_UI_VALUE_NA   0x00
	UI request struct value qualifiers. More...
#define	NFC_OUTCOME_UI_VALUE_AMOUNT   0x01
#define	NFC_OUTCOME_UI_VALUE_BALANCE   0x02
#define	NFC_OUTCOME_UI_VERSION_0   0x00
	UI request struct version ID. More...
#define	NFC_OUTCOME_UI_VERSION   0x01
#define	NFC_OUTCOME_TYPE_NA   0x00
	Outcome types definitions. More...
#define	NFC_OUTCOME_TYPE_SELECT_NEXT   0x01
#define	NFC_OUTCOME_TYPE_TRY_AGAIN   0x02
#define	NFC_OUTCOME_TYPE_TRY_ANOTHER_INTERFACE   0x03
#define	NFC_OUTCOME_TYPE_APPROVED   0x11
#define	NFC_OUTCOME_TYPE_DECLINED   0x12
#define	NFC_OUTCOME_TYPE_ONLINE_REQUEST   0x21
#define	NFC_OUTCOME_TYPE_ONLINE_PIN   0x22
#define	NFC_OUTCOME_TYPE_END_APPLICATION   0xF1
#define	NFC_OUTCOME_TYPE_CUSTOM   0xFA
#define	NFC_OUTCOME_CVM_NA   0x00
	Outcome requested CVM definitions. More...
#define	NFC_OUTCOME_CVM_NO_CVM   0x1F
#define	NFC_OUTCOME_CVM_ONLINE_PIN   0x02
#define	NFC_OUTCOME_CVM_CD_CVM   0x20
#define	NFC_OUTCOME_CVM_SIGNATURE   0x1E
#define	NFC_OUTCOME_CVM_CUSTOM   0xFF
#define	NFC_OUTCOME_OPT_UI   0x0001
	Outcome options definitions. More...
#define	NFC_OUTCOME_OPT_UI_RESTART   0x0002
#define	NFC_OUTCOME_OPT_DATA_RECORD   0x0004
#define	NFC_OUTCOME_OPT_DISCRETIONARY_DATA   0x0008
#define	NFC_OUTCOME_OPT_RECEIPT   0x0010
#define	NFC_OUTCOME_OPT_FIELD_OFF_REQUEST   0x0020
#define	NFC_OUTCOME_START_TYPE_NA   0x00
	Outcome start types definitions. More...
#define	NFC_OUTCOME_START_TYPE_A   0x01
#define	NFC_OUTCOME_START_TYPE_B   0x02
#define	NFC_OUTCOME_START_TYPE_C   0x03
#define	NFC_OUTCOME_START_TYPE_D   0x04
#define	NFC_OUTCOME_RESPONSE_NA   0x00
	Outcome online response types definitions. More...
#define	NFC_OUTCOME_RESPONSE_EMV_DATA   0x01
#define	NFC_OUTCOME_RESPONSE_ANY   0x02
#define	NFC_OUTCOME_ALT_NA   0x00
	Outcome alt interface definitions. More...
#define	NFC_OUTCOME_ALT_MASK_CHIP   0x01
#define	NFC_OUTCOME_ALT_MASK_MS   0x02
#define	NFC_OUTCOME_IND_MS_MODE   0x01
	Outcome indicators definitions. More...
#define	NFC_OUTCOME_IND_EMV_MODE   0x02
#define	NFC_OUTCOME_IND_CD_CVM_REQUESTED   0x04
#define	NFC_OUTCOME_IND_EMPTY_CL   0x08
#define	NFC_OUTCOME_IND_APDU_RRP_TIMEOUT   0x10
#define	NFC_OUTCOME_IND_MAND_CPLC_MISSED   0x20
#define	NFC_OUTCOME_VERSION_0   0x00
	Outcome struct version ID. More...
#define	NFC_OUTCOME_VERSION   0x01

Detailed Description

NFC Outcome structs & macros used to handle transaction by EP & Kernels.

Macro Definition Documentation

NFC_OUTCOME_ALT_MASK_CHIP

#define NFC_OUTCOME_ALT_MASK_CHIP   0x01

contact chip

NFC_OUTCOME_ALT_MASK_MS

#define NFC_OUTCOME_ALT_MASK_MS   0x02

magnetic stripe

NFC_OUTCOME_ALT_NA

#define NFC_OUTCOME_ALT_NA   0x00

Outcome alt interface definitions.

n/a

NFC_OUTCOME_CVM_CD_CVM

#define NFC_OUTCOME_CVM_CD_CVM   0x20

CD-CVM verified

NFC_OUTCOME_CVM_CUSTOM

#define NFC_OUTCOME_CVM_CUSTOM   0xFF

Custom CVM requested

NFC_OUTCOME_CVM_NA

#define NFC_OUTCOME_CVM_NA   0x00

Outcome requested CVM definitions.

n/a

NFC_OUTCOME_CVM_NO_CVM

#define NFC_OUTCOME_CVM_NO_CVM   0x1F

No CVM

NFC_OUTCOME_CVM_ONLINE_PIN

#define NFC_OUTCOME_CVM_ONLINE_PIN   0x02

Online PIN requested

NFC_OUTCOME_CVM_SIGNATURE

#define NFC_OUTCOME_CVM_SIGNATURE   0x1E

Signature requested

NFC_OUTCOME_IND_APDU_RRP_TIMEOUT

#define NFC_OUTCOME_IND_APDU_RRP_TIMEOUT   0x10

RRP timeout condition

NFC_OUTCOME_IND_CD_CVM_REQUESTED

#define NFC_OUTCOME_IND_CD_CVM_REQUESTED   0x04

Restart by CD-CVM request, EMV Book C-4, 8.2.4.1, and other...

NFC_OUTCOME_IND_EMPTY_CL

#define NFC_OUTCOME_IND_EMPTY_CL   0x08

Empty candidate list, EMV Book B, 3.3.2.7

NFC_OUTCOME_IND_EMV_MODE

#define NFC_OUTCOME_IND_EMV_MODE   0x02

EMV Node Transaction

NFC_OUTCOME_IND_MAND_CPLC_MISSED

#define NFC_OUTCOME_IND_MAND_CPLC_MISSED   0x20

mandatory cplc missed

NFC_OUTCOME_IND_MS_MODE

#define NFC_OUTCOME_IND_MS_MODE   0x01

Outcome indicators definitions.

MS Mode Transaction

NFC_OUTCOME_INIT

#define NFC_OUTCOME_INIT	(		DATA,
			SIZE,
			TRAN_DATA
	)

Value:

do  \
{   \
    NFC_OUTCOME_RESET((DATA), (SIZE));  \
    NFC_OUTCOME_UI_INIT(&(DATA)->UI, sizeof((DATA)->UI), (TRAN_DATA));  \
    NFC_OUTCOME_UI_INIT(&(DATA)->UIRestart, sizeof((DATA)->UIRestart), (TRAN_DATA));    \
} while (0)

Outcome reset macro definition.

NFC_OUTCOME_OPT_DATA_RECORD

#define NFC_OUTCOME_OPT_DATA_RECORD   0x0004

Data Record provided

NFC_OUTCOME_OPT_DISCRETIONARY_DATA

#define NFC_OUTCOME_OPT_DISCRETIONARY_DATA   0x0008

Discretionary data provided

NFC_OUTCOME_OPT_FIELD_OFF_REQUEST

#define NFC_OUTCOME_OPT_FIELD_OFF_REQUEST   0x0020

Field off requested

NFC_OUTCOME_OPT_RECEIPT

#define NFC_OUTCOME_OPT_RECEIPT   0x0010

Receipt requested

NFC_OUTCOME_OPT_UI

#define NFC_OUTCOME_OPT_UI   0x0001

Outcome options definitions.

UI update requested

NFC_OUTCOME_OPT_UI_RESTART

#define NFC_OUTCOME_OPT_UI_RESTART   0x0002

UI update on restart requested

NFC_OUTCOME_RESET

#define NFC_OUTCOME_RESET	(		DATA,
			SIZE
	)

Value:

do  \
{   \
    KER_MEM_SET(DATA, SIZE, 0, SIZE);   \
    (DATA)->usSize = SIZE;  \
    (DATA)->btVersion = NFC_OUTCOME_VERSION; \
    (DATA)->btOutcomeType = NFC_OUTCOME_TYPE_NA; \
    (DATA)->btStart = NFC_OUTCOME_START_TYPE_NA; \
    (DATA)->btOnlineResponse = NFC_OUTCOME_RESPONSE_NA; \
    (DATA)->btCVM = NFC_OUTCOME_CVM_NA; \
    (DATA)->btAltInterfacePreference = NFC_OUTCOME_ALT_NA; \
    NFC_OUTCOME_UI_RESET(&(DATA)->UI, sizeof((DATA)->UI));  \
    NFC_OUTCOME_UI_RESET(&(DATA)->UIRestart, sizeof((DATA)->UIRestart));    \
} while (0)

Outcome reset macro definition.

NFC_OUTCOME_RESPONSE_ANY

#define NFC_OUTCOME_RESPONSE_ANY   0x02

Response with any data expected

NFC_OUTCOME_RESPONSE_EMV_DATA

#define NFC_OUTCOME_RESPONSE_EMV_DATA   0x01

Response with EMV-data expected

NFC_OUTCOME_RESPONSE_NA

#define NFC_OUTCOME_RESPONSE_NA   0x00

Outcome online response types definitions.

n/a

NFC_OUTCOME_START_TYPE_A

#define NFC_OUTCOME_START_TYPE_A   0x01

Start A

NFC_OUTCOME_START_TYPE_B

#define NFC_OUTCOME_START_TYPE_B   0x02

Start B

NFC_OUTCOME_START_TYPE_C

#define NFC_OUTCOME_START_TYPE_C   0x03

Start C

NFC_OUTCOME_START_TYPE_D

#define NFC_OUTCOME_START_TYPE_D   0x04

Start D

NFC_OUTCOME_START_TYPE_NA

#define NFC_OUTCOME_START_TYPE_NA   0x00

Outcome start types definitions.

n/a

NFC_OUTCOME_TYPE_APPROVED

#define NFC_OUTCOME_TYPE_APPROVED   0x11

Approved

NFC_OUTCOME_TYPE_CUSTOM

#define NFC_OUTCOME_TYPE_CUSTOM   0xFA

Custom Outcome

NFC_OUTCOME_TYPE_DECLINED

#define NFC_OUTCOME_TYPE_DECLINED   0x12

Declined

NFC_OUTCOME_TYPE_END_APPLICATION

#define NFC_OUTCOME_TYPE_END_APPLICATION   0xF1

End Application

NFC_OUTCOME_TYPE_NA

#define NFC_OUTCOME_TYPE_NA   0x00

Outcome types definitions.

n/a

NFC_OUTCOME_TYPE_ONLINE_PIN

#define NFC_OUTCOME_TYPE_ONLINE_PIN   0x22

Request Online PIN

NFC_OUTCOME_TYPE_ONLINE_REQUEST

#define NFC_OUTCOME_TYPE_ONLINE_REQUEST   0x21

Online Request

NFC_OUTCOME_TYPE_SELECT_NEXT

#define NFC_OUTCOME_TYPE_SELECT_NEXT   0x01

Select Next

NFC_OUTCOME_TYPE_TRY_AGAIN

#define NFC_OUTCOME_TYPE_TRY_AGAIN   0x02

Try Again

NFC_OUTCOME_TYPE_TRY_ANOTHER_INTERFACE

#define NFC_OUTCOME_TYPE_TRY_ANOTHER_INTERFACE   0x03

Try Another Interface

NFC_OUTCOME_UI_CARD_READ_SUCCESS

#define NFC_OUTCOME_UI_CARD_READ_SUCCESS   0x05

Card Read Successfully (Remove Card)

NFC_OUTCOME_UI_ERROR_PROCESSING

#define NFC_OUTCOME_UI_ERROR_PROCESSING   0x06

Processing Error

NFC_OUTCOME_UI_IDLE

#define NFC_OUTCOME_UI_IDLE   0x02

Idle

NFC_OUTCOME_UI_INIT

#define NFC_OUTCOME_UI_INIT	(		UI,
			SIZE,
			TRAN_DATA
	)

Value:

do  \
{   \
    NFC_OUTCOME_UI_RESET((UI), (SIZE)); \
    NFC_OUTCOME_UI_SET_LANG_PREF((UI), (TRAN_DATA));    \
} while (0)

UI init with lang pref macro definition.

NFC_OUTCOME_UI_MSG_APPROVED

#define NFC_OUTCOME_UI_MSG_APPROVED   0x03

"Approved"

NFC_OUTCOME_UI_MSG_APPROVED_SIGN

#define NFC_OUTCOME_UI_MSG_APPROVED_SIGN   0x1A

"Please, Sign Receipt"

NFC_OUTCOME_UI_MSG_AUTHORISATION_WAIT

#define NFC_OUTCOME_UI_MSG_AUTHORISATION_WAIT   0x1B

"Authorizing, please wait"

NFC_OUTCOME_UI_MSG_BLANK

#define NFC_OUTCOME_UI_MSG_BLANK   0x1E

CLEAR DISPLAY

NFC_OUTCOME_UI_MSG_CARD_READ_OK_REMOVE_CARD

#define NFC_OUTCOME_UI_MSG_CARD_READ_OK_REMOVE_CARD   0x17

"Card read OK. Remove card"

NFC_OUTCOME_UI_MSG_ENTER_PIN

#define NFC_OUTCOME_UI_MSG_ENTER_PIN   0x09

"Enter PIN"

NFC_OUTCOME_UI_MSG_EXPIRED_DECLINE

#define NFC_OUTCOME_UI_MSG_EXPIRED_DECLINE   0xA1

"The application is expired, transaction declined" UPI EMV C-7 4.2.4.5

NFC_OUTCOME_UI_MSG_EXPIRED_ONLINE

#define NFC_OUTCOME_UI_MSG_EXPIRED_ONLINE   0xA0

"The application is expired, transaction is going online" UPI EMV C-7 4.2.4.5

NFC_OUTCOME_UI_MSG_INSERT_CARD

#define NFC_OUTCOME_UI_MSG_INSERT_CARD   0x1D

"Please insert card"

NFC_OUTCOME_UI_MSG_INSERT_OR_SWIPE_CARD

#define NFC_OUTCOME_UI_MSG_INSERT_OR_SWIPE_CARD   0x18

"Please insert or swipe card"

NFC_OUTCOME_UI_MSG_INSERT_OR_SWIPE_OR_TRY_ANOTHER

#define NFC_OUTCOME_UI_MSG_INSERT_OR_SWIPE_OR_TRY_ANOTHER   0x1C

"Insert, swipe or try another card"

NFC_OUTCOME_UI_MSG_NA

#define NFC_OUTCOME_UI_MSG_NA   0xFF

Outcome User Interface Message ID definitions.

N/A (defined as FF in C-2

NFC_OUTCOME_UI_MSG_NOT_AUTHORISED

#define NFC_OUTCOME_UI_MSG_NOT_AUTHORISED   0x07

"Not authorized"

NFC_OUTCOME_UI_MSG_PRESENT_CARD

#define NFC_OUTCOME_UI_MSG_PRESENT_CARD   0x15

"Present card"

NFC_OUTCOME_UI_MSG_PRESENT_CARD_AGAIN

#define NFC_OUTCOME_UI_MSG_PRESENT_CARD_AGAIN   0x21

"Present card again"

NFC_OUTCOME_UI_MSG_PRESENT_ONE_CARD_ONLY

#define NFC_OUTCOME_UI_MSG_PRESENT_ONE_CARD_ONLY   0x19

"Please present one card only"

NFC_OUTCOME_UI_MSG_PROCESSING

#define NFC_OUTCOME_UI_MSG_PROCESSING   0x16

"Processing"

NFC_OUTCOME_UI_MSG_PROCESSING_ERROR

#define NFC_OUTCOME_UI_MSG_PROCESSING_ERROR   0x0F

"Processing error"

NFC_OUTCOME_UI_MSG_REMOVE_CARD

#define NFC_OUTCOME_UI_MSG_REMOVE_CARD   0x10

"Remove card"

NFC_OUTCOME_UI_MSG_SEE_PHONE_INSTRUCTIONS

#define NFC_OUTCOME_UI_MSG_SEE_PHONE_INSTRUCTIONS   0x20

"See Phone for Instructions"

NFC_OUTCOME_UI_MSG_WELCOME

#define NFC_OUTCOME_UI_MSG_WELCOME   0x14

"Welcome"

NFC_OUTCOME_UI_NA

#define NFC_OUTCOME_UI_NA   0x00

Outcome User Interface status types definitions.

n/a

NFC_OUTCOME_UI_NOT_READY

#define NFC_OUTCOME_UI_NOT_READY   0x01

Not Ready

NFC_OUTCOME_UI_PROCESSING

#define NFC_OUTCOME_UI_PROCESSING   0x04

Processing

NFC_OUTCOME_UI_READY_TO_READ

#define NFC_OUTCOME_UI_READY_TO_READ   0x03

Ready to Read (Present Card)

NFC_OUTCOME_UI_RESET

#define NFC_OUTCOME_UI_RESET	(		UI,
			SIZE
	)

Value:

do  \
{   \
    KER_MEM_SET(UI, SIZE, 0, SIZE); \
    (UI)->usSize = SIZE;    \
    (UI)->btVersion = NFC_OUTCOME_UI_VERSION; \
    (UI)->btMessageID = NFC_OUTCOME_UI_MSG_NA;  \
    (UI)->btStatus = NFC_OUTCOME_UI_NA; \
} while (0)

UI reset macro definition.

NFC_OUTCOME_UI_SET_LANG_PREF

#define NFC_OUTCOME_UI_SET_LANG_PREF	(		UI,
			TRAN_DATA
	)

Value:

do  \
{   \
    if (((TRAN_DATA) != KER_NULL)   && ((TRAN_DATA)->btLangPrefLen > 0))    \
    {   \
        (UI)->btLangPrefLen = ((TRAN_DATA)->btLangPrefLen <= sizeof((UI)->ar_btLangPref)) ? (TRAN_DATA)->btLangPrefLen : sizeof((UI)->ar_btLangPref);   \
        KER_MEM_CPY((UI)->ar_btLangPref, sizeof((UI)->ar_btLangPref), (TRAN_DATA)->ar_btLangPref, (UI)->btLangPrefLen); \
    }   \
} while (0)

UI set lang pref macro definition.

NFC_OUTCOME_UI_VALUE_AMOUNT

#define NFC_OUTCOME_UI_VALUE_AMOUNT   0x01

amount value qualifier

NFC_OUTCOME_UI_VALUE_BALANCE

#define NFC_OUTCOME_UI_VALUE_BALANCE   0x02

balance value qualifier

NFC_OUTCOME_UI_VALUE_NA

#define NFC_OUTCOME_UI_VALUE_NA   0x00

UI request struct value qualifiers.

n/a - extra value not present

NFC_OUTCOME_UI_VERSION

#define NFC_OUTCOME_UI_VERSION   0x01

leng pref, value qualifier, currency code added...

NFC_OUTCOME_UI_VERSION_0

#define NFC_OUTCOME_UI_VERSION_0   0x00

UI request struct version ID.

base version w/o value qualifier

NFC_OUTCOME_VERSION

#define NFC_OUTCOME_VERSION   0x01

version info added...

NFC_OUTCOME_VERSION_0

#define NFC_OUTCOME_VERSION_0   0x00

Outcome struct version ID.

base version w/o version info